home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Source Code / Visual Basic Source Code.iso / vbsource / vbdatabs / vbdref.h < prev    next >
C/C++ Source or Header  |  1999-03-14  |  5KB  |  127 lines
  1. // ------------------------------- //
  2. // -------- Start of File -------- //
  3. // ------------------------------- //
  4. // ----------------------------------------------------------- //
  5. // C++ Header File Name: vbdref.h
  6. // Compiler Used: MSVC40, DJGPP 2.7.2.1, GCC 2.7.2.1, HP CPP 10.24
  7. // Produced By: Doug Gaer   
  8. // File Creation Date: 02/03/1997  
  9. // Date Last Modified: 03/15/1999
  10. // Copyright (c) 1997 Douglas M. Gaer
  11. // ----------------------------------------------------------- // 
  12. // ---------- Include File Description and Details  ---------- // 
  13. // ----------------------------------------------------------- // 
  14. /*
  15. The VBD C++ classes are copyright (c) 1997, by Douglas M. Gaer.
  16. All those who put this code or its derivatives in a commercial
  17. product MUST mention this copyright in their documentation for
  18. users of the products in which this code or its derivative
  19. classes are used. Otherwise, you have the freedom to redistribute
  20. verbatim copies of this source code, adapt it to your specific
  21. needs, or improve the code and release your improvements to the
  22. public provided that the modified files carry prominent notices
  23. stating that you changed the files and the date of any change.
  24.  
  25. THIS SOFTWARE IS PROVIDED "AS IS" WITHOUT WARRANTY OF ANY KIND.
  26. THE ENTIRE RISK OF THE QUALITY AND PERFORMANCE OF THIS SOFTWARE
  27. IS WITH YOU. SHOULD ANY ELEMENT OF THIS SOFTWARE PROVE DEFECTIVE,
  28. YOU WILL ASSUME THE COST OF ALL NECESSARY SERVICING, REPAIR, OR
  29. CORRECTION.
  30.  
  31. Reference counting is a technique used to ensure the safe
  32. deletion or modification of an object when a copy of the
  33. object exists. In order to create reference counted objects,
  34. a class must inherit the CountedObject class to embed a
  35. reference count into each object. The vbdRefCount class is
  36. used to handle pointers to reference counted objects. It
  37. works by storing pointers to objects in containers, rather
  38. than the objects themselves. 
  39.  
  40. NOTE: This class is also implemented as template class
  41. named RefCount. To avoid portablity problems with HPUX CPP
  42. it was renamed and coded directly for VBDFile class objects.
  43.  
  44. The template implementation named RefCount caused a linker
  45. error when compling under HPUX 10.20 (using HPUX CPP 1024)
  46. in some wxWindows applications.
  47. */
  48. // ----------------------------------------------------------- //
  49. #ifndef __VDBREFCOUNT_HPP__
  50. #define __VBDREFCOUNT_HPP__
  51.  
  52. #include "refcount.h" // Need for the CountedObject class
  53.  
  54. #ifdef __NOT_USING_TEMPLATE_CLASS__
  55.  
  56. class VBDFile; // Forward the class calling convention
  57.  
  58. // (R)eference (C)ount class
  59. // The RefCount class is used to handle reference-counted objects.
  60. // Reference counted pointers work like normal pointers, except
  61. // they keep track of the number of references to the objects they
  62. // point to. To set up a reference counted pointer to an object,
  63. // allocate and initialize the object on the heap using the new
  64. // operator, and then pass a pointer to the object in a call to
  65. // the RefCount constructor.
  66. class vbdRefCount
  67. {
  68. public:
  69.   vbdRefCount(VBDFile *ptr = 0) { ObjectPtr = ptr; }
  70.   ~vbdRefCount() { Unbind(); }
  71.   vbdRefCount(const vbdRefCount &ptr) { // Copy constructor
  72.     // Called when a RefCount pointer is passed by value or copied.
  73.     // Like normal pointers only the ObjectPtr is copied, not the
  74.     // object pointed to by ObjectPtr. The aliasing that ocurrs at
  75.     // this point is recorded by incrementing the reference count.
  76.     Bind(ptr);
  77.   }
  78.     
  79.   void operator=(const vbdRefCount &ptr) {
  80.     // Assignment operator using share semantics.
  81.     // This assignment operator does not allow chain assignments
  82.     NewBinding(ptr);
  83.   }
  84.   
  85.   // int is a dummy parameter used to set the pointer to a NULL
  86.   void operator=(int) { Unbind(); ObjectPtr = 0; }
  87.  
  88. protected:
  89.   void Bind(const vbdRefCount &ptr);
  90.   void Unbind();
  91.   void NewBinding(const vbdRefCount &ptr);
  92.  
  93. protected:
  94.   // VBDFile assumed to be a structure having IncRefCount(),
  95.   // DecRefCount(), and Referenced() member functions inherited
  96.   // from the CountedObject class.
  97.   VBDFile *ObjectPtr;
  98.  
  99. public:
  100.   // The overloaded * and -> operators allow reference
  101.   // counted pointers to be de-referenced like ordinary pointers.
  102.   VBDFile &operator*() const { return *ObjectPtr; } 
  103.   VBDFile *operator->() const { return ObjectPtr; }
  104.  
  105.   // Used to test whether a RefCount is null
  106.   int operator!() { return ObjectPtr == 0; } // True if equal 0
  107.   operator int() { return ObjectPtr != 0; }  // True if not equal 0
  108.   
  109.   friend int operator==(const vbdRefCount &a, const vbdRefCount &b)
  110.   {
  111.     return a.ObjectPtr == b.ObjectPtr;
  112.   }
  113.   
  114.   friend int operator!=(const vbdRefCount &a, const vbdRefCount &b)
  115.   {
  116.     return a.ObjectPtr != b.ObjectPtr;
  117.   }
  118. };
  119. #endif // __NOT_USING_TEMPLATE_CLASS__
  120.  
  121.  
  122. #endif // __VBDREFCOUNT_HPP__
  123. // ----------------------------------------------------------- //
  124. // ------------------------------- //
  125. // --------- End of File --------- //
  126. // ------------------------------- //
  127.